Skip to content

feat(dashboard): render complete dashboards as sixel - #1410

Merged
BYK merged 13 commits into
mainfrom
feat/sixel-shared-renderer
Aug 21, 2026
Merged

feat(dashboard): render complete dashboards as sixel#1410
BYK merged 13 commits into
mainfrom
feat/sixel-shared-renderer

Conversation

@jared-outpost

@jared-outpost jared-outpost Bot commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Closes #1231.

dashboard view --sixel now renders the complete dashboard into one Sixel canvas when terminal geometry is known, preserving the original widget grid. It renders timeseries, categorical bars, scalar values, tables, text, errors, and unsupported states with a single pixel renderer, so capable terminals never mix ASCII widgets with Sixel graphics.

The command always falls back to the complete character dashboard when Sixel capability or terminal cell geometry is unavailable.

The chart core remains resolution-independent, downsamples dense time series, preserves the muted gray Other series, and provides compact tick labels.

Verification

  • pnpm run typecheck
  • pnpm run lint
  • pnpm run test:unit (9,260 passed; 16 skipped)

Coverage includes categorical bars, scalar/table/text/error/unsupported widgets, adjacent widget positioning, dense-series tails, and the no-geometry ASCII fallback.

@vercel

vercel Bot commented Aug 11, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
cli Ready Ready Preview Aug 21, 2026 11:01pm

Request Review

@BYK BYK added the jared Trigger the Jared agent to work on stuff label Aug 19, 2026
@BYK
BYK marked this pull request as ready for review August 19, 2026 07:19
@github-actions github-actions Bot added the risk: medium PR risk score: medium label Aug 19, 2026
Comment thread packages/cli/src/lib/formatters/dashboard.ts Outdated
Comment thread packages/cli/src/lib/formatters/dashboard.ts Outdated
Comment thread packages/cli/src/lib/formatters/chart-core.ts
Comment thread packages/cli/src/lib/formatters/dashboard.ts Outdated
Comment thread packages/cli/src/lib/formatters/dashboard.ts
Comment thread packages/cli/src/lib/formatters/dashboard.ts
@github-actions github-actions Bot added risk: high PR risk score: high and removed risk: medium PR risk score: medium labels Aug 19, 2026
Comment thread packages/cli/src/lib/formatters/dashboard.ts Outdated
Comment thread packages/cli/src/lib/formatters/dashboard.ts Outdated
@BYK

BYK commented Aug 19, 2026

Copy link
Copy Markdown
Member

Jared, I see no reason for mixing sixel widgets and ASCII ones. If we have sixel everything we have should be possible to render in sixel

@BYK

BYK commented Aug 19, 2026

Copy link
Copy Markdown
Member

Jared?

jared-outpost Bot and others added 6 commits August 21, 2026 20:21
Rework the opt-in sixel timeseries rendering (#1231) around a single
resolution-independent chart core instead of a standalone sixel-only
renderer.

chart-core.ts builds a ChartModel from a TimeseriesResult and rasterizes
it into an RGBA canvas at a caller-chosen resolution. The sixel path
(pixel resolution) is now a thin wrapper over the core, and the ASCII
renderer shares the same categorical palette, so both outputs agree on
hue and stacking. Output target picks the resolution upfront.

Opt-in via --sixel / SENTRY_DASHBOARD_SIXEL=1 / displayType
timeseries_sixel; falls back to text when the terminal lacks support.

Closes #1231
Address review feedback on the sixel timeseries rendering:

- Pull sixel-eligible widgets out of the side-by-side framebuffer and
  render them full-width after the character grid. A DCS image advances
  the cursor by many rows, so composing it into a shared terminal row
  trampled the widget's own borders and any neighbor on those rows.
- Exclude categorical_bar from sixel: the chart core only models
  time-bucket columns, so categorical widgets keep the ASCII
  per-category renderer instead of being drawn as the wrong viz.
- Downsample dense series to the pixel budget in rasterizeChart, so
  ranges with more buckets than ~half the canvas width no longer clip
  their tail off-canvas (mirrors the ASCII sparkline path).
- Use the shared EscapeType for the local esc state in fitToWidth.

Adds tests for the categorical exclusion, standalone-block layout, and
dense-series downsampling.
When sixel-eligible widgets are stripped out of the framebuffer, the
remaining widgets kept their original `layout.y`, so `renderGrid`
still allocated blank bands for the removed rows and the sixel images
were always appended after the whole grid (changing vertical order).

Compress `layout.y` values by dense rank while preserving relative
order within the same original band, so the grid packs contiguously
from y=0 with no holes and no reordering of left/right widgets on the
same row.
The previous dense-rank compression only renumbered `y` values and
ignored `layout.h`. Widgets that were stacked (`y_new = y_prev + h_prev`)
collapsed to consecutive integers and overlapped.

Pack by accumulating the tallest height in each original y-band so the
next band starts immediately below the previous tallest widget.
Detect widgets whose start y lies inside another widget's span (the
common tall-left + short-right pattern). When the layout is staggered,
skip packing and keep the original y values so the grid is rendered
exactly as the dashboard author laid it out.

Staggered packing is out of scope for this opt-in experimental path.
@BYK
BYK force-pushed the feat/sixel-shared-renderer branch from 4a1ee6c to 4a61b5a Compare August 21, 2026 22:24
@BYK BYK changed the title feat(dashboard): sixel timeseries via shared pixel-core renderer feat(dashboard): render complete dashboards as sixel Aug 21, 2026
Comment thread packages/cli/src/lib/formatters/sixel-dashboard.ts Outdated
Comment thread packages/cli/src/lib/formatters/sixel-dashboard.ts Outdated
Comment thread packages/cli/src/lib/formatters/sixel-dashboard.ts
Comment thread packages/cli/src/lib/sixel-image.ts

@cursor cursor Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 2 potential issues.

There are 3 total unresolved issues (including 1 from previous review).

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 71ada2b. Configure here.

Comment thread packages/cli/src/lib/formatters/sixel-dashboard.ts Outdated
Comment thread packages/cli/test/lib/formatters/sixel-dashboard.test.ts Outdated
Comment thread packages/cli/src/lib/formatters/sixel-dashboard.ts Outdated
Comment thread packages/cli/src/lib/formatters/sixel-dashboard.ts Outdated
Comment thread packages/cli/src/lib/formatters/sixel-dashboard.ts
@BYK
BYK merged commit b28cec4 into main Aug 21, 2026
32 checks passed
@BYK
BYK deleted the feat/sixel-shared-renderer branch August 21, 2026 23:10
jared-outpost Bot added a commit that referenced this pull request Aug 25, 2026
…missing env vars, new commands (#1461)

## Documentation Audit Report (2026-08-24)

Weekly automated audit comparing the CLI implementation against its
documentation. Changes since the last merged audit (PR #1400,
2026-08-11) include: the `sentry cli completion` command (#1427), sixel
dashboard rendering (#1410), the `--environment` explore fix (#1442),
and the 0.43.0 release.

---

## Findings & Fixes

### A. Undocumented or missing commands/subcommands

| Command | Source | Expected doc location | Status |
|---------|--------|----------------------|--------|
| `sentry cli completion` | `src/commands/cli/completion.ts` (added in
#1427) | `apps/cli-docs/src/fragments/commands/cli.md` | **Fixed** —
added examples for bash, zsh, fish |

All other commands in `src/commands/` have corresponding fragment files.
Hidden backward-compat aliases (`send-event`, `send-envelope`,
`bash-hook`, `whoami`, plural aliases) are correctly excluded from docs.

### B. Undocumented flags

| Flag | Command | Source | Doc file | Status |
|------|---------|--------|----------|--------|
| `--sixel` / `-s` | `sentry dashboard view` |
`src/commands/dashboard/view.ts` | `fragments/commands/dashboard.md` |
**Fixed** — added example |

All other non-hidden flags are auto-generated into the command docs via
`generate-command-docs.ts`.

### C. Missing usage examples

No new gaps. The `sentry cli completion` command was the only command
without examples, now fixed.

### D. Stale descriptions

| Command/Flag | Code brief | Doc description | Status |
|-------------|-----------|-----------------|--------|
| `sentry explore --environment` | Was: "Replay environment filter for
--dataset replays" | Now works for all datasets (fixed in #1442) |
**Fixed** — updated brief to "Environment filter" |

### E. Missing route mappings in skill generator

**N/A** — `ROUTE_TO_REFERENCE` was removed and replaced with automatic
1:1 route-to-reference mapping via `groupRoutesByReference()` in
`script/generate-skill.ts`. No manual mapping to go stale.

### F. Installation / distribution gaps

No new gaps. Install script flags (`--no-modify-path`,
`--no-completions`, `--no-agent-skills`) and env vars
(`SENTRY_INSTALL_DIR`, `SENTRY_VERSION`, `SENTRY_INIT`) are documented
in `getting-started.mdx`. Platform support table matches `.craft.yml`
targets (macOS x64/arm64, Linux x64/arm64, Windows x64).

### G. Undocumented environment variables

| Variable | Referenced in | Expected doc | Status |
|----------|-------------|-------------|--------|
| `DO_NOT_TRACK` | `src/lib/telemetry.ts` | `configuration.md`
(generated from env-registry) | **Fixed** — added to env-registry.ts |
| `SENTRY_PIPELINE` | `src/commands/build/upload.ts`,
`src/lib/build/index.ts` | `configuration.md` | **Fixed** — added to
env-registry.ts |

Remaining niche/internal vars NOT added (intentionally excluded from
user-facing docs):
- `SENTRY_ENVIRONMENT` — bash-hook template only
- `SENTRY_CLI_NO_EXIT_TRAP` — bash-hook template internal
- `SENTRY_SCAN_DISABLE_WORKERS` — internal performance tuning
- `SENTRY_CLI_INTEGRATION_TEST_VERSION_OVERRIDE` — test-only
- `SENTRY_RN_*` — internal react-native wrapper vars
- `SENTRY_TRACES_SAMPLE_RATE` — inherited from SDK, not a CLI config

### H. Auth / self-hosted gaps

No new gaps. OAuth scopes in `self-hosted.md` and `DEVELOPMENT.md` are
auto-generated (`GENERATED:START oauth-scopes`). The `--url` flag for
`auth login` and `SENTRY_HOST`/`SENTRY_URL` behavior are documented.
Token priority (OAuth > env token unless `SENTRY_FORCE_ENV_TOKEN`) is
correct.

### I. Plugin/skills gaps

No new gaps since the last audit. Skills install to `~/.claude` and
`~/.agents` only. The `agentic-usage.md` correctly states this.
Detection of other agents (Cursor, Windsurf, Copilot, etc.) is for
telemetry and the docs correctly list them as "supported" agents (they
can use the CLI, just not via auto-installed skills).

### J. README / DEVELOPMENT.md / contributing.md drift

| File | Claim | Reality | Status |
|------|-------|---------|--------|
| `script/generate-docs-sections.ts` line 210 | "TypeScript types and
Zod schemas" | Migrated to Valibot in #1389 (merged Aug 7) | **Fixed** |
| `apps/cli-docs/src/content/docs/features.md` | DSN detection table
lists 6 languages with specific `Sentry.init()` patterns | Scanner uses
a universal DSN URL regex across 30+ file extensions | **Fixed** —
updated table to match actual TEXT_EXTENSIONS set |

Node.js version claims (v22.15+ for dev, >=20 for runtime) are correct.
Build commands, test commands, and license (`FSL-1.1-Apache-2.0`) are
all accurate.

---

## Top 5 Most Impactful Fixes (prioritized)

1. **DSN detection language table overhaul** (`features.md`) — The
previous table implied language-specific `Sentry.init()` pattern
matching, which is misleading. The universal regex approach supports 30+
file extensions. Users of Kotlin, Rust, Swift, Dart, C#, etc. would not
have known their DSNs are detected.

2. **Missing `sentry cli completion` docs** (`cli.md` fragment) — New
command from #1427 with no usage examples. Users discovering shell
completions would miss this standalone alternative to `sentry cli
setup`.

3. **Stale `--environment` flag brief** (`explore.ts`) — After #1442
fixed `--environment` to work for all datasets, the flag's `brief`
string still said "Replay environment filter". Users would think it only
applies to replays.

4. **Missing env vars in registry** (`env-registry.ts`) — `DO_NOT_TRACK`
(industry-standard telemetry opt-out) and `SENTRY_PIPELINE` (build
plugin identification) were referenced in code but absent from the
generated configuration page.

5. **Zod→Valibot drift in project structure**
(`generate-docs-sections.ts`) — The auto-generated project structure
tree in `contributing.md` still said "Zod schemas" despite the migration
to Valibot in #1389. Contributors would be confused about which
validation library to use.

<div><a
href="https://cursor.com/agents/bc-2961de96-bee8-48d4-becb-d403a42a7cb6?cursor_ref=pr_footer&cursor_cta=open_in_web"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://cursor.com/assets/images/open-in-web-dark.png"><source
media="(prefers-color-scheme: light)"
srcset="https://cursor.com/assets/images/open-in-web-light.png"><img
alt="Open in Web" width="114" height="28"
src="https://cursor.com/assets/images/open-in-web-dark.png"></picture></a>&nbsp;<a
href="https://cursor.com/automations/8b0c0f35-da5e-409d-984c-5e39518ffb8a"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://cursor.com/assets/images/view-automation-dark.png"><source
media="(prefers-color-scheme: light)"
srcset="https://cursor.com/assets/images/view-automation-light.png"><img
alt="View Automation" width="141" height="28"
src="https://cursor.com/assets/images/view-automation-dark.png"></picture></a>&nbsp;</div>

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: Miguel Betegón <miguelbetegongarcia@gmail.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: jared-outpost[bot] <jared-outpost[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

jared Trigger the Jared agent to work on stuff risk: high PR risk score: high

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Explore sixel for dashboard rendering

1 participant